Certificate Collection Management

Certificate CollectionClosed The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). Management is used to:

Figure 60: Certificate Collection Management

Certificate Collection Management Operations

To open the Certificate Collection Management grid, browse to Certificates > Collection Management in the Management Portal.

The Certificate Collection Management page includes the following collection action buttons from the grid header:

  • View

    Highlight a row in the collection management grid and click View at the top of the grid, or choose View from the right-click menu, to be taken to a new window with the list of certificates filtered for the specific criteria of that collection.

  • Delete

    To delete a collection, highlight the row in the collection management grid and click Delete at the top of the grid or choose Delete from the right-click menu. You will receive a Confirm Operation message. Click OK to delete.

    Figure 61: Delete Certificate Collection

  • Show on Dashboard/Remove from Dashboard

    To change whether or not a collection appears on the dashboard in the Collections panel, highlight the row in the collection management grid and click Show on Dashboard or Remove from Dashboard (depending on that collection's current state) at the top of the grid, or choose the action from the right-click menu. For a Show on Dashboard action you will receive a confirmation message to remind you that only 25 collections can show on the dashboard. Click OK to add the collection to the dashboard, which toggles Yes in the On Dashboard grid column. Selecting Remove from Dashboard will remove the collection from the dashboard, which toggles No in the On Dashboard grid column, with no confirmation message.

    Figure 62: Show Certificate Collection

  • Navigation Order

    To change the order and/or the list of collections which show on the Navigator, click Navigation Order at the top of the grid. This will open the Collection Order in Navigator dialog, from which you can define the order and/or the list of the collections that are displayed on the Navigator.

    This display has a search bar and a grid displaying the collections in the Navigator, pre-populated in their current order. A maximum of 25 collections can be displayed on the Navigator. The grid includes these columns:

    • The checkbox column is used to select the row to perform an action upon. Only one row at a time may be selected.

    • The untitled column shows the collections' order position.

    • The Collections column displays the name of the collection.

    Actions on the dialog are:

    • Search for a collection to add:

      Select a certificate collection to add to the Navigator. To narrow the list of results in the search select field, begin typing a search string in the search field.

      Click Add to add the collection to the grid. An error will display if the collection is already in the Navigator. Once a collection is added, a Collection Added message will display. The added collection will display at the end of the ordered list.

    • Select the checkbox of a collection in the grid and click:

      • Move Up: Move it up one line.

      • Move Down: Move it down one line.

      • Move to Top: Move it to the top of the list.

      • Move to Bottom: Move it to the bottom of the list.

      • Remove: Remove the collection from display on the Navigator. The collection can still be used in reports, alerts, workflows, and on the dashboard, as well as accessed through the collection manager.

    Upon Save, the Navigator's collections list refreshes to reflect the new collection ordering. Upon Close, if there are unsaved changes you are prompted with a confirmation dialog.

    Figure 63: Order Certificate Collection

    Tip:  If a custom sort order is not defined, the collections display in the order in which they were created.
    Note:  The order defined here does not affect the sort order for the collections displayed on the dashboard. That is controlled separately using dashboard settings (see Dashboard: Collections).
Important:  All automatically created collections are included on the menu by default. They are created for fresh installations of Keyfactor Command only, not upgrades, so as not to overwrite any user-defined collection for existing installations.
Tip:  Click the help icon () next to the Certificate Collection Management page title to open the Keyfactor Software & Documentation Portal to this section. You will receive a prompt indicating:

You are being redirected to an external website. Would you like to proceed?

You can also find the help icon () at the top of the page next to the Log Out button. From here you can choose to open either the Keyfactor Software & Documentation Portal at the home page or the Keyfactor API Endpoint Utility.

Keyfactor provides two sets of documentation: the On-Premises Documentation Suite and the Managed Services Documentation Suite. Which documentation set is accessed is determined by the Application Settings: On-Prem Documentation setting (see Application Settings: Console Tab).